Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance API documentation #237

Closed

Conversation

KafayatYusuf
Copy link

What type of PR is this?

Check all applicable

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation
  • πŸ§‘β€πŸ’» Refactor
  • βœ… Test
  • πŸ€– Build or CI
  • ❓ Other (Correction of spelling errors and punctuation)

Related Issue:

  • Corrects grammatical errors and punctuation in the markdown
  • Removes trailing backslashes

What does this PR do?

  • Removes trailing backslashes
  • Updates API description
  • Add googles docstrings to functions
  • Add status response codes (200,400,403,404,408 & 500) to endpoints
  • Corrects grammatical errors and punctuation in the markdown
  • Contributes to this issue [https://github.com/Enhance API documentation and examplesΒ #219]

Consideration:

  • Updating the description helps the user to understand what the API is all about
  • Removing trailing backslashes help to keep a consistent format and avoid errors
  • Status response codes help user to identify and know the responses to expect

How to test ?

Notes for the reviewer. How to test this change?

Screenshots :

Please provide screenshots of the change.

Checklists:

Checklist before requesting review :

  • πŸ“– Read the HOT Code of Conduct: https://docs.hotosm.org/code-of-conduct
  • πŸ‘·β€β™€οΈ Create small PRs. In most cases, this will be possible.
  • βœ… Provide tests for your changes.
  • πŸ“ Use descriptive commit messages.
  • πŸ“— Update any related documentation and include any relevant screenshots.

[optional] What gif best describes this PR or how it makes you feel?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant